def_is_subtype(expected,basetype):ifisinstance(expected,tuple):returnall(_is_subtype(e,basetype)foreinexpected)returnisinstance(expected,type)andissubclass(expected,basetype)class_BaseTestCaseContext:def__init__(self,test_case):self.test_case=test_casedef_raiseFailure(self,standardMsg):msg=self.test_case._formatMessage(self.msg,standardMsg)raiseself.test_case.failureException(msg)class_AssertRaisesBaseContext(_BaseTestCaseContext):def__init__(self,expected,test_case,expected_regex=None):_BaseTestCaseContext.__init__(self,test_case)self.expected=expectedself.test_case=test_caseifexpected_regexisnotNone:expected_regex=re.compile(expected_regex)self.expected_regex=expected_regexself.obj_name=Noneself.msg=Nonedefhandle(self,name,args,kwargs):""" If args is empty, assertRaises/Warns is being used as a context manager, so check for a 'msg' kwarg and return self. If args is not empty, call a callable passing positional and keyword arguments. """ifnot_is_subtype(self.expected,self._base_type):raiseTypeError('%s() arg 1 must be %s'%(name,self._base_type_str))ifargsandargs[0]isNone:warnings.warn("callable is None",DeprecationWarning,3)args=()ifnotargs:self.msg=kwargs.pop('msg',None)ifkwargs:warnings.warn('%r is an invalid keyword argument for ''this function'%next(iter(kwargs)),DeprecationWarning,3)returnselfcallable_obj,*args=argstry:self.obj_name=callable_obj.__name__exceptAttributeError:self.obj_name=str(callable_obj)withself:callable_obj(*args,**kwargs)class_AssertRaisesContext(_AssertRaisesBaseContext):"""A context manager used to implement TestCase.assertRaises* methods."""_base_type=BaseException_base_type_str='an exception type or tuple of exception types'def__enter__(self):returnselfdef__exit__(self,exc_type,exc_value,tb):ifexc_typeisNone:try:exc_name=self.expected.__name__exceptAttributeError:exc_name=str(self.expected)ifself.obj_name:self._raiseFailure("{} not raised by {}".format(exc_name,self.obj_name))else:self._raiseFailure("{} not raised".format(exc_name))else:traceback.clear_frames(tb)ifnotissubclass(exc_type,self.expected):# let unexpected exceptions pass throughreturnFalse# store exception, without traceback, for later retrievalself.exception=exc_value.with_traceback(None)ifself.expected_regexisNone:returnTrueexpected_regex=self.expected_regexifnotexpected_regex.search(str(exc_value)):self._raiseFailure('"{}" does not match "{}"'.format(expected_regex.pattern,str(exc_value)))returnTrueclass_AssertWarnsContext(_AssertRaisesBaseContext):"""A context manager used to implement TestCase.assertWarns* methods."""_base_type=Warning_base_type_str='a warning type or tuple of warning types'def__enter__(self):# The __warningregistry__'s need to be in a pristine state for tests# to work properly.forvinsys.modules.values():ifgetattr(v,'__warningregistry__',None):v.__warningregistry__={}self.warnings_manager=warnings.catch_warnings(record=True)self.warnings=self.warnings_manager.__enter__()warnings.simplefilter("always",self.expected)returnselfdef__exit__(self,exc_type,exc_value,tb):self.warnings_manager.__exit__(exc_type,exc_value,tb)ifexc_typeisnotNone:# let unexpected exceptions pass throughreturntry:exc_name=self.expected.__name__exceptAttributeError:exc_name=str(self.expected)first_matching=Noneforminself.warnings:w=m.messageifnotisinstance(w,self.expected):continueiffirst_matchingisNone:first_matching=wif(self.expected_regexisnotNoneandnotself.expected_regex.search(str(w))):continue# store warning for later retrievalself.warning=wself.filename=m.filenameself.lineno=m.linenoreturn# Now we simply try to choose a helpful failure messageiffirst_matchingisnotNone:self._raiseFailure('"{}" does not match "{}"'.format(self.expected_regex.pattern,str(first_matching)))ifself.obj_name:self._raiseFailure("{} not triggered by {}".format(exc_name,self.obj_name))else:self._raiseFailure("{} not triggered".format(exc_name))_LoggingWatcher=collections.namedtuple("_LoggingWatcher",["records","output"])class_CapturingHandler(logging.Handler):""" A logging handler capturing all (raw and formatted) logging output. """def__init__(self):logging.Handler.__init__(self)self.watcher=_LoggingWatcher([],[])defflush(self):passdefemit(self,record):self.watcher.records.append(record)msg=self.format(record)self.watcher.output.append(msg)class_AssertLogsContext(_BaseTestCaseContext):"""A context manager used to implement TestCase.assertLogs()."""LOGGING_FORMAT="%(levelname)s:%(name)s:%(message)s"def__init__(self,test_case,logger_name,level):_BaseTestCaseContext.__init__(self,test_case)self.logger_name=logger_nameiflevel:self.level=logging._nameToLevel.get(level,level)else:self.level=logging.INFOself.msg=Nonedef__enter__(self):ifisinstance(self.logger_name,logging.Logger):logger=self.logger=self.logger_nameelse:logger=self.logger=logging.getLogger(self.logger_name)formatter=logging.Formatter(self.LOGGING_FORMAT)handler=_CapturingHandler()handler.setFormatter(formatter)self.watcher=handler.watcherself.old_handlers=logger.handlers[:]self.old_level=logger.levelself.old_propagate=logger.propagatelogger.handlers=[handler]logger.setLevel(self.level)logger.propagate=Falsereturnhandler.watcherdef__exit__(self,exc_type,exc_value,tb):self.logger.handlers=self.old_handlersself.logger.propagate=self.old_propagateself.logger.setLevel(self.old_level)ifexc_typeisnotNone:# let unexpected exceptions pass throughreturnFalseiflen(self.watcher.records)==0:self._raiseFailure("no logs of level {} or higher triggered on {}".format(logging.getLevelName(self.level),self.logger.name))

[docs]classTestCase(object):"""A class whose instances are single test cases. By default, the test code itself should be placed in a method named 'runTest'. If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute. Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively. If it is necessary to override the __init__ method, the base class __init__ method must always be called. It is important that subclasses should not change the signature of their __init__ method, since instances of the classes are instantiated automatically by parts of the framework in order to be run. When subclassing TestCase, you can set these attributes: * failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'. * longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in *addition* to any explicit message passed. * maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required. """failureException=AssertionErrorlongMessage=TruemaxDiff=80*8# If a string is longer than _diffThreshold, use normal comparison instead# of difflib. See #11763._diffThreshold=2**16# Attribute used by TestSuite for classSetUp_classSetupFailed=Falsedef__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=methodNameself._outcome=Noneself._testMethodDoc='No test'try:testMethod=getattr(self,methodName)exceptAttributeError:ifmethodName!='runTest':# we allow instantiation with no explicit method name# but not an *incorrect* or missing method nameraiseValueError("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')

[docs]defaddTypeEqualityFunc(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

[docs]defaddCleanup(self,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)."""self._cleanups.append((function,args,kwargs))

[docs]defsetUp(self):"Hook method for setting up the test fixture before exercising it."pass

[docs]deftearDown(self):"Hook method for deconstructing the test fixture after testing it."pass

@classmethod

[docs]defsetUpClass(cls):"Hook method for setting up class fixture before running tests in the class."

@classmethod

[docs]deftearDownClass(cls):"Hook method for deconstructing the class fixture after running all tests in the class."

[docs]defshortDescription(self):"""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. """doc=self._testMethodDocreturndocanddoc.split("\n")[0].strip()orNone

def__eq__(self,other):iftype(self)isnottype(other):returnNotImplementedreturnself._testMethodName==other._testMethodNamedef__hash__(self):returnhash((type(self),self._testMethodName))def__str__(self):return"%s (%s)"%(self._testMethodName,strclass(self.__class__))def__repr__(self):return"<%s testMethod=%s>"% \
(strclass(self.__class__),self._testMethodName)def_addSkip(self,result,test_case,reason):addSkip=getattr(result,'addSkip',None)ifaddSkipisnotNone:addSkip(test_case,reason)else:warnings.warn("TestResult has no addSkip method, skips not reported",RuntimeWarning,2)result.addSuccess(test_case)@contextlib.contextmanagerdefsubTest(self,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. """ifnotself._outcome.result_supports_subtests:yieldreturnparent=self._subtestifparentisNone:params_map=collections.ChainMap(params)else:params_map=parent.params.new_child(params)self._subtest=_SubTest(self,msg,params_map)try:withself._outcome.testPartExecutor(self._subtest,isTest=True):yieldifnotself._outcome.success:result=self._outcome.resultifresultisnotNoneandresult.failfast:raise_ShouldStopelifself._outcome.expectedFailure:# If the test is expecting a failure, we really want to# stop now and register the expected failure.raise_ShouldStopfinally:self._subtest=parentdef_feedErrorsToResult(self,result,errors):fortest,exc_infoinerrors:ifisinstance(test,_SubTest):result.addSubTest(test.test_case,test,exc_info)elifexc_infoisnotNone:ifissubclass(exc_info[0],self.failureException):result.addFailure(test,exc_info)else:result.addError(test,exc_info)def_addExpectedFailure(self,result,exc_info):try:addExpectedFailure=result.addExpectedFailureexceptAttributeError:warnings.warn("TestResult has no addExpectedFailure method, reporting as passes",RuntimeWarning)result.addSuccess(self)else:addExpectedFailure(self,exc_info)def_addUnexpectedSuccess(self,result):try:addUnexpectedSuccess=result.addUnexpectedSuccessexceptAttributeError:warnings.warn("TestResult has no addUnexpectedSuccess method, reporting as failure",RuntimeWarning)# We need to pass an actual exception and traceback to addFailure,# otherwise the legacy result can choke.try:raise_UnexpectedSuccessfromNoneexcept_UnexpectedSuccess:result.addFailure(self,sys.exc_info())else:addUnexpectedSuccess(self)

[docs]defdoCleanups(self):"""Execute all cleanup functions. Normally called for you after tearDown."""outcome=self._outcomeor_Outcome()whileself._cleanups:function,args,kwargs=self._cleanups.pop()withoutcome.testPartExecutor(self):function(*args,**kwargs)# return this for backwards compatibility# even though we no longer us it internallyreturnoutcome.success

def__call__(self,*args,**kwds):returnself.run(*args,**kwds)

[docs]defdebug(self):"""Run the test without collecting errors in a TestResult"""self.setUp()getattr(self,self._testMethodName)()self.tearDown()whileself._cleanups:function,args,kwargs=self._cleanups.pop(-1)function(*args,**kwargs)

[docs]defskipTest(self,reason):"""Skip this test."""raiseSkipTest(reason)

[docs]deffail(self,msg=None):"""Fail immediately, with the given message."""raiseself.failureException(msg)

[docs]defassertFalse(self,expr,msg=None):"""Check that the expression is false."""ifexpr:msg=self._formatMessage(msg,"%s is not false"%safe_repr(expr))raiseself.failureException(msg)

[docs]defassertTrue(self,expr,msg=None):"""Check that the expression is true."""ifnotexpr:msg=self._formatMessage(msg,"%s is not true"%safe_repr(expr))raiseself.failureException(msg)

def_formatMessage(self,msg,standardMsg):"""Honour the longMessage attribute when generating failure messages. If longMessage is False this means: * Use only an explicit message if it is provided * Otherwise use the standard message for the assert If longMessage is True: * Use the standard message * If an explicit message is provided, plus ' : ' and the explicit message """ifnotself.longMessage:returnmsgorstandardMsgifmsgisNone:returnstandardMsgtry:# don't switch to '{}' formatting in Python 2.X# it changes the way unicode input is handledreturn'%s : %s'%(standardMsg,msg)exceptUnicodeDecodeError:return'%s : %s'%(safe_repr(standardMsg),safe_repr(msg))

[docs]defassertRaises(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)returncontext.handle('assertRaises',args,kwargs)

defassertWarns(self,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) """context=_AssertWarnsContext(expected_warning,self)returncontext.handle('assertWarns',args,kwargs)defassertLogs(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_getAssertEqualityFunc(self,first,second):"""Get a detailed comparison function for the types of the two args. Returns: A callable accepting (first, second, msg=None) that will raise a failure exception if first != second with a useful human readable error message for those types. """## NOTE(gregory.p.smith): I considered isinstance(first, type(second))# and vice versa. I opted for the conservative approach in case# subclasses are not intended to be compared in detail to their super# class instances using a type equality func. This means testing# subtypes won't automagically use the detailed comparison. Callers# should use their type specific assertSpamEqual method to compare# subclasses if the detailed comparison is desired and appropriate.# See the discussion in http://bugs.python.org/issue2578.#iftype(first)istype(second):asserter=self._type_equality_funcs.get(type(first))ifasserterisnotNone:ifisinstance(asserter,str):asserter=getattr(self,asserter)returnasserterreturnself._baseAssertEqualdef_baseAssertEqual(self,first,second,msg=None):"""The default assertEqual implementation, not type specific."""ifnotfirst==second:standardMsg='%s != %s'%_common_shorten_repr(first,second)msg=self._formatMessage(msg,standardMsg)raiseself.failureException(msg)

[docs]defassertEqual(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)

[docs]defassertNotEqual(self,first,second,msg=None):"""Fail if the two objects are equal as determined by the '!=' operator. """ifnotfirst!=second:msg=self._formatMessage(msg,'%s == %s'%(safe_repr(first),safe_repr(second)))raiseself.failureException(msg)

[docs]defassertAlmostEqual(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 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. """iffirst==second:# shortcutreturnifdeltaisnotNoneandplacesisnotNone:raiseTypeError("specify delta or places not both")ifdeltaisnotNone:ifabs(first-second)<=delta:returnstandardMsg='%s != %s within %s delta'%(safe_repr(first),safe_repr(second),safe_repr(delta))else:ifplacesisNone:places=7ifround(abs(second-first),places)==0:returnstandardMsg='%s != %s within %r places'%(safe_repr(first),safe_repr(second),places)msg=self._formatMessage(msg,standardMsg)raiseself.failureException(msg)

[docs]defassertNotAlmostEqual(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 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. """ifdeltaisnotNoneandplacesisnotNone:raiseTypeError("specify delta or places not both")ifdeltaisnotNone:ifnot(first==second)andabs(first-second)>delta:returnstandardMsg='%s == %s within %s delta'%(safe_repr(first),safe_repr(second),safe_repr(delta))else:ifplacesisNone:places=7ifnot(first==second)andround(abs(second-first),places)!=0:returnstandardMsg='%s == %s within %r places'%(safe_repr(first),safe_repr(second),places)msg=self._formatMessage(msg,standardMsg)raiseself.failureException(msg)

[docs]defassertSequenceEqual(self,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. """ifseq_typeisnotNone:seq_type_name=seq_type.__name__ifnotisinstance(seq1,seq_type):raiseself.failureException('First sequence is not a %s: %s'%(seq_type_name,safe_repr(seq1)))ifnotisinstance(seq2,seq_type):raiseself.failureException('Second sequence is not a %s: %s'%(seq_type_name,safe_repr(seq2)))else:seq_type_name="sequence"differing=Nonetry:len1=len(seq1)except(TypeError,NotImplementedError):differing='First %s has no length. Non-sequence?'%(seq_type_name)ifdifferingisNone:try:len2=len(seq2)except(TypeError,NotImplementedError):differing='Second %s has no length. Non-sequence?'%(seq_type_name)ifdifferingisNone:ifseq1==seq2:returndiffering='%ss differ: %s != %s\n'%((seq_type_name.capitalize(),)+_common_shorten_repr(seq1,seq2))foriinrange(min(len1,len2)):try:item1=seq1[i]except(TypeError,IndexError,NotImplementedError):differing+=('\nUnable to index element %d of first %s\n'%(i,seq_type_name))breaktry:item2=seq2[i]except(TypeError,IndexError,NotImplementedError):differing+=('\nUnable to index element %d of second %s\n'%(i,seq_type_name))breakifitem1!=item2:differing+=('\nFirst differing element %d:\n%s\n%s\n'%((i,)+_common_shorten_repr(item1,item2)))breakelse:if(len1==len2andseq_typeisNoneandtype(seq1)!=type(seq2)):# The sequences are the same, but have differing types.returniflen1>len2:differing+=('\nFirst %s contains %d additional ''elements.\n'%(seq_type_name,len1-len2))try:differing+=('First extra element %d:\n%s\n'%(len2,safe_repr(seq1[len2])))except(TypeError,IndexError,NotImplementedError):differing+=('Unable to index element %d ''of first %s\n'%(len2,seq_type_name))eliflen1<len2:differing+=('\nSecond %s contains %d additional ''elements.\n'%(seq_type_name,len2-len1))try:differing+=('First extra element %d:\n%s\n'%(len1,safe_repr(seq2[len1])))except(TypeError,IndexError,NotImplementedError):differing+=('Unable to index element %d ''of second %s\n'%(len1,seq_type_name))standardMsg=differingdiffMsg='\n'+'\n'.join(difflib.ndiff(pprint.pformat(seq1).splitlines(),pprint.pformat(seq2).splitlines()))standardMsg=self._truncateMessage(standardMsg,diffMsg)msg=self._formatMessage(msg,standardMsg)self.fail(msg)

[docs]defassertListEqual(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)

[docs]defassertTupleEqual(self,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. """self.assertSequenceEqual(tuple1,tuple2,msg,seq_type=tuple)

[docs]defassertSetEqual(self,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). """try:difference1=set1.difference(set2)exceptTypeErrorase:self.fail('invalid type when attempting set difference: %s'%e)exceptAttributeErrorase:self.fail('first argument does not support set difference: %s'%e)try:difference2=set2.difference(set1)exceptTypeErrorase:self.fail('invalid type when attempting set difference: %s'%e)exceptAttributeErrorase:self.fail('second argument does not support set difference: %s'%e)ifnot(difference1ordifference2):returnlines=[]ifdifference1:lines.append('Items in the first set but not the second:')foritemindifference1:lines.append(repr(item))ifdifference2:lines.append('Items in the second set but not the first:')foritemindifference2:lines.append(repr(item))standardMsg='\n'.join(lines)self.fail(self._formatMessage(msg,standardMsg))

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

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

[docs]defassertIs(self,expr1,expr2,msg=None):"""Just like self.assertTrue(a is b), but with a nicer default message."""ifexpr1isnotexpr2:standardMsg='%s is not %s'%(safe_repr(expr1),safe_repr(expr2))self.fail(self._formatMessage(msg,standardMsg))

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

[docs]defassertDictEqual(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')ifd1!=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))

defassertCountEqual(self,first,second,msg=None):"""An unordered sequence comparison asserting that the same elements, regardless of order. If the same element occurs more than once, it verifies that the elements occur the same number of times. 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)exceptTypeError:# Handle case with unhashable elementsdifferences=_count_diff_all_purpose(first_seq,second_seq)else:iffirst==second:returndifferences=_count_diff_hashable(first_seq,second_seq)ifdifferences:standardMsg='Element counts were not equal:\n'lines=['First has %d, Second has %d: %r'%difffordiffindifferences]diffMsg='\n'.join(lines)standardMsg=self._truncateMessage(standardMsg,diffMsg)msg=self._formatMessage(msg,standardMsg)self.fail(msg)

[docs]defassertMultiLineEqual(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')iffirst!=second:# don't use difflib if the strings are too longif(len(first)>self._diffThresholdorlen(second)>self._diffThreshold):self._baseAssertEqual(first,second,msg)firstlines=first.splitlines(keepends=True)secondlines=second.splitlines(keepends=True)iflen(firstlines)==1andfirst.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))

[docs]defassertLess(self,a,b,msg=None):"""Just like self.assertTrue(a < b), but with a nicer default message."""ifnota<b:standardMsg='%s not less than %s'%(safe_repr(a),safe_repr(b))self.fail(self._formatMessage(msg,standardMsg))

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

[docs]defassertGreater(self,a,b,msg=None):"""Just like self.assertTrue(a > b), but with a nicer default message."""ifnota>b:standardMsg='%s not greater than %s'%(safe_repr(a),safe_repr(b))self.fail(self._formatMessage(msg,standardMsg))

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

[docs]defassertIsNone(self,obj,msg=None):"""Same as self.assertTrue(obj is None), with a nicer default message."""ifobjisnotNone:standardMsg='%s is not None'%(safe_repr(obj),)self.fail(self._formatMessage(msg,standardMsg))

[docs]defassertIsNotNone(self,obj,msg=None):"""Included for symmetry with assertIsNone."""ifobjisNone:standardMsg='unexpectedly None'self.fail(self._formatMessage(msg,standardMsg))

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

[docs]defassertNotIsInstance(self,obj,cls,msg=None):"""Included for symmetry with assertIsInstance."""ifisinstance(obj,cls):standardMsg='%s is an instance of %r'%(safe_repr(obj),cls)self.fail(self._formatMessage(msg,standardMsg))

defassertRaisesRegex(self,expected_exception,expected_regex,*args,**kwargs):"""Asserts that the message in a raised exception matches a regex. Args: expected_exception: Exception class expected to be raised. expected_regex: Regex (re pattern object or string) expected to be found in error message. args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used when assertRaisesRegex is used as a context manager. """context=_AssertRaisesContext(expected_exception,self,expected_regex)returncontext.handle('assertRaisesRegex',args,kwargs)defassertWarnsRegex(self,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. Args: expected_warning: Warning class expected to be triggered. expected_regex: Regex (re pattern object or string) expected to be found in error message. args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used when assertWarnsRegex is used as a context manager. """context=_AssertWarnsContext(expected_warning,self,expected_regex)returncontext.handle('assertWarnsRegex',args,kwargs)defassertRegex(self,text,expected_regex,msg=None):"""Fail the test unless the text matches the regular expression."""ifisinstance(expected_regex,(str,bytes)):assertexpected_regex,"expected_regex must not be empty."expected_regex=re.compile(expected_regex)ifnotexpected_regex.search(text):standardMsg="Regex didn't match: %r not found in %r"%(expected_regex.pattern,text)# _formatMessage ensures the longMessage option is respectedmsg=self._formatMessage(msg,standardMsg)raiseself.failureException(msg)defassertNotRegex(self,text,unexpected_regex,msg=None):"""Fail the test if the text matches the regular expression."""ifisinstance(unexpected_regex,(str,bytes)):unexpected_regex=re.compile(unexpected_regex)match=unexpected_regex.search(text)ifmatch:standardMsg='Regex matched: %r matches %r in %r'%(text[match.start():match.end()],unexpected_regex.pattern,text)# _formatMessage ensures the longMessage option is respectedmsg=self._formatMessage(msg,standardMsg)raiseself.failureException(msg)def_deprecate(original_func):defdeprecated_func(*args,**kwargs):warnings.warn('Please use {0} instead.'.format(original_func.__name__),DeprecationWarning,2)returnoriginal_func(*args,**kwargs)returndeprecated_func# see #9424failUnlessEqual=assertEquals=_deprecate(assertEqual)failIfEqual=assertNotEquals=_deprecate(assertNotEqual)failUnlessAlmostEqual=assertAlmostEquals=_deprecate(assertAlmostEqual)failIfAlmostEqual=assertNotAlmostEquals=_deprecate(assertNotAlmostEqual)failUnless=assert_=_deprecate(assertTrue)failUnlessRaises=_deprecate(assertRaises)failIf=_deprecate(assertFalse)assertRaisesRegexp=_deprecate(assertRaisesRegex)assertRegexpMatches=_deprecate(assertRegex)assertNotRegexpMatches=_deprecate(assertNotRegex)

[docs]classFunctionTestCase(TestCase):"""A test case that wraps a test function. This is useful for slipping pre-existing test functions into the unittest framework. Optionally, set-up and tidy-up functions can be supplied. As with TestCase, the tidy-up ('tearDown') function will always be called if the set-up ('setUp') function ran successfully. """def__init__(self,testFunc,setUp=None,tearDown=None,description=None):super(FunctionTestCase,self).__init__()self._setUpFunc=setUpself._tearDownFunc=tearDownself._testFunc=testFuncself._description=descriptiondefsetUp(self):ifself._setUpFuncisnotNone:self._setUpFunc()deftearDown(self):ifself._tearDownFuncisnotNone:self._tearDownFunc()defrunTest(self):self._testFunc()defid(self):returnself._testFunc.__name__def__eq__(self,other):ifnotisinstance(other,self.__class__):returnNotImplementedreturnself._setUpFunc==other._setUpFuncand \
self._tearDownFunc==other._tearDownFuncand \
self._testFunc==other._testFuncand \
self._description==other._descriptiondef__hash__(self):returnhash((type(self),self._setUpFunc,self._tearDownFunc,self._testFunc,self._description))def__str__(self):return"%s (%s)"%(strclass(self.__class__),self._testFunc.__name__)def__repr__(self):return"<%s tec=%s>"%(strclass(self.__class__),self._testFunc)defshortDescription(self):ifself._descriptionisnotNone:returnself._descriptiondoc=self._testFunc.__doc__returndocanddoc.split("\n")[0].strip()orNone

class_SubTest(TestCase):def__init__(self,test_case,message,params):super().__init__()self._message=messageself.test_case=test_caseself.params=paramsself.failureException=test_case.failureExceptiondefrunTest(self):raiseNotImplementedError("subtests cannot be run directly")def_subDescription(self):parts=[]ifself._messageisnot_subtest_msg_sentinel:parts.append("[{}]".format(self._message))ifself.params:params_desc=', '.join("{}={!r}".format(k,v)for(k,v)insorted(self.params.items()))parts.append("({})".format(params_desc))return" ".join(parts)or'(<subtest>)'defid(self):return"{}{}".format(self.test_case.id(),self._subDescription())defshortDescription(self):"""Returns a one-line description of the subtest, or None if no description has been provided. """returnself.test_case.shortDescription()def__str__(self):return"{}{}".format(self.test_case,self._subDescription())