TestCase

(class from pyomo.common.unittest)

class pyomo.common.unittest.TestCase(methodName='runTest')

Bases: TestCase

A Pyomo-specific class whose instances are single test cases.

This class derives from unittest.TestCase and provides the following additional functionality:

• additional assertions:

  • assertStructuredAlmostEqual()

  • assertExpressionsEqual()

  • assertExpressionsStructurallyEqual()

• updated assertions:

  • assertRaisesRegex()

unittest.TestCase documentation

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.

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

Methods

__init__([methodName])	Create an instance of the class that will use the named test method when executed.
addClassCleanup(function, /, *args, **kwargs)	Same as addCleanup, except the cleanup items are called even if setUpClass fails (unlike tearDownClass).
addCleanup(function, /, *args, **kwargs)	Add a function, with arguments, to be called when the test is completed.
addTypeEqualityFunc(typeobj, function)	Add a type specific assertEqual style function to compare a type.
assertAlmostEqual(first, second[, places, ...])	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.
assertAlmostEquals(**kwargs)
assertCountEqual(first, second[, msg])	Asserts that two iterables have the same elements, the same number of times, without regard to order.
assertDictContainsSubset(subset, dictionary)	Checks whether dictionary is a superset of subset.
assertDictEqual(d1, d2[, msg])
assertEqual(first, second[, msg])	Fail if the two objects are unequal as determined by the '==' operator.
assertEquals(**kwargs)
assertExpressionsEqual(a, b[, ...])	Assert that two Pyomo expressions are equal.
assertExpressionsStructurallyEqual(a, b[, ...])	Assert that two Pyomo expressions are structurally equal.
assertFalse(expr[, msg])	Check that the expression is false.
assertGreater(a, b[, msg])	Just like self.assertTrue(a > b), but with a nicer default message.
assertGreaterEqual(a, b[, msg])	Just like self.assertTrue(a >= b), but with a nicer default message.
assertIn(member, container[, msg])	Just like self.assertTrue(a in b), but with a nicer default message.
assertIs(expr1, expr2[, msg])	Just like self.assertTrue(a is b), but with a nicer default message.
assertIsInstance(obj, cls[, msg])	Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.
assertIsNone(obj[, msg])	Same as self.assertTrue(obj is None), with a nicer default message.
assertIsNot(expr1, expr2[, msg])	Just like self.assertTrue(a is not b), but with a nicer default message.
assertIsNotNone(obj[, msg])	Included for symmetry with assertIsNone.
assertLess(a, b[, msg])	Just like self.assertTrue(a < b), but with a nicer default message.
assertLessEqual(a, b[, msg])	Just like self.assertTrue(a <= b), but with a nicer default message.
assertListEqual(list1, list2[, msg])	A list-specific equality assertion.
assertLogs([logger, level])	Fail unless a log message of level level or higher is emitted on logger_name or its children.
assertMultiLineEqual(first, second[, msg])	Assert that two multi-line strings are equal.
assertNoLogs([logger, level])	Fail unless no log messages of level level or higher are emitted on logger_name or its children.
assertNotAlmostEqual(first, second[, ...])	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.
assertNotAlmostEquals(**kwargs)
assertNotEqual(first, second[, msg])	Fail if the two objects are equal as determined by the '!=' operator.
assertNotEquals(**kwargs)
assertNotIn(member, container[, msg])	Just like self.assertTrue(a not in b), but with a nicer default message.
assertNotIsInstance(obj, cls[, msg])	Included for symmetry with assertIsInstance.
assertNotRegex(text, unexpected_regex[, msg])	Fail the test if the text matches the regular expression.
assertNotRegexpMatches(**kwargs)
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.
assertRaisesRegex(expected_exception, ...)	Asserts that the message in a raised exception matches a regex.
assertRaisesRegexp(**kwargs)
assertRegex(text, expected_regex[, msg])	Fail the test unless the text matches the regular expression.
assertRegexpMatches(**kwargs)
assertSequenceEqual(seq1, seq2[, msg, seq_type])	An equality assertion for ordered sequences (like lists and tuples).
assertSetEqual(set1, set2[, msg])	A set-specific equality assertion.
assertStructuredAlmostEqual(first, second[, ...])	Test that first and second are equal up to a tolerance
assertTrue(expr[, msg])	Check that the expression is true.
assertTupleEqual(tuple1, tuple2[, msg])	A tuple-specific equality assertion.
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.
assertWarnsRegex(expected_warning, ...)	Asserts that the message in a triggered warning matches a regexp.
assert_(**kwargs)
countTestCases()
debug()	Run the test without collecting errors in a TestResult
defaultTestResult()
doClassCleanups()	Execute all class cleanup functions.
doCleanups()	Execute all cleanup functions.
enterClassContext(cm)	Same as enterContext, but class-wide.
enterContext(cm)	Enters the supplied context manager.
fail([msg])	Fail immediately, with the given message.
failIf(**kwargs)
failIfAlmostEqual(**kwargs)
failIfEqual(**kwargs)
failUnless(**kwargs)
failUnlessAlmostEqual(**kwargs)
failUnlessEqual(**kwargs)
failUnlessRaises(**kwargs)
id()
run([result])
setUp()	Hook method for setting up the test fixture before exercising it.
setUpClass()	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.
skipTest(reason)	Skip this test.
subTest([msg])	Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters.
tearDown()	Hook method for deconstructing the test fixture after testing it.
tearDownClass()	Hook method for deconstructing the class fixture after running all tests in the class.

Attributes

longMessage
maxDiff

Member Documentation

failureException

alias of AssertionError

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

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

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.

Parameters:

• 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.

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.

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.

assertDictContainsSubset(subset, dictionary, msg=None)

Checks whether dictionary is a superset of subset.

assertEqual(first, second, msg=None)

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

assertExpressionsEqual(a, b, include_named_exprs=True, places=None)

Assert that two Pyomo expressions are equal.

This converts the expressions a and b into prefix notation and then compares the resulting lists. All nodes in the tree are compared using py:meth:assertEqual (or py:meth:assertAlmostEqual)

Parameters:

• a (ExpressionBase or native type)

• b (ExpressionBase or native type)

• include_named_exprs (bool) – If True (the default), the comparison expands all named expressions when generating the prefix notation

• places (float) – Number of decimal places required for equality of floating point numbers in the expression. If None (the default), the expressions must be exactly equal.

assertExpressionsStructurallyEqual(a, b, include_named_exprs=True, places=None)

Assert that two Pyomo expressions are structurally equal.

This converts the expressions a and b into prefix notation and then compares the resulting lists. Operators and (non-native type) leaf nodes in the prefix representation are converted to strings before comparing (so that things like variables can be compared across clones or pickles)

Parameters:

• a (ExpressionBase or native type)

• b (ExpressionBase or native type)

• include_named_exprs (bool) – If True (the default), the comparison expands all named expressions when generating the prefix notation

• places (float) – Number of decimal places required for equality of floating point numbers in the expression. If None (the default), the expressions must be exactly equal.

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.

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.

Parameters:

• 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.

assertLogs(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'])

assertMultiLineEqual(first, second, msg=None)

Assert that two multi-line strings are equal.

assertNoLogs(logger=None, level=None)

Fail unless no log messages of level level or higher are emitted on logger_name or its children.

This method must be used as a context manager.

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.

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

assertNotRegex(text, unexpected_regex, msg=None)

Fail the test if the text matches the regular expression.

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)

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

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

This is a light weight wrapper around unittest.TestCase.assertRaisesRegex() that adds handling of a normalize_whitespace keyword argument that normalizes all consecutive whitespace in the exception message to a single space before checking the regular expression.

Parameters:

• expected_exception (Exception) – Exception class expected to be raised.

• expected_regex (re.Pattern or str) – Regular expression expected to be found in error message.

• *args – Function to be called and extra positional args.

• **kwargs – Extra keyword args.

• msg (str) – Optional message used in case of failure. Can only be used when assertRaisesRegex is used as a context manager.

• normalize_whitespace (bool, default=False) – If True, collapses consecutive whitespace (including newlines) into a single space before checking against the regular expression

assertRegex(text, expected_regex, 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.

Parameters:

• 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.

Parameters:

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

assertStructuredAlmostEqual(first, second, places=None, msg=None, delta=None, reltol=None, abstol=None, allow_second_superset=False, item_callback=<function _floatOrCall>)

Test that first and second are equal up to a tolerance

This compares first and second using both an absolute (abstol) and relative (reltol) tolerance. It will recursively descend into Sequence and Mapping containers (allowing for the relative comparison of structured data including lists and dicts).

places and delta is supported for compatibility with assertAlmostEqual. If places is supplied, abstol is computed as 10**-places. delta is an alias for abstol.

If none of {abstol, reltol, places, delta} are specified, reltol defaults to 1e-7.

If allow_second_superset is True, then:

• only key/value pairs found in mappings in first are compared to second (allowing mappings in second to contain extra keys)

• only values found in sequences in first are compared to second (allowing sequences in second to contain extra values)

The relative error is computed for numerical values as

abs(first - second) / max(abs(first), abs(second))

only when first != second (thereby avoiding divide-by-zero errors).

Items (entries other than Sequence / Mapping containers, matching strings, and items that satisfy first is second) are passed to the item_callback before testing equality and relative tolerances.

Raises exception if first and second are not equal within tolerance.

Parameters:

• first – the first value to compare

• second – the second value to compare

• places (int) – first and second are considered equivalent if their difference is between places decimal places; equivalent to abstol = 10**-places (included for compatibility with assertAlmostEqual)

• msg (str) – the message to raise on failure

• delta (float) – alias for abstol

• abstol (float) – the absolute tolerance. first and second are considered equivalent if their absolute difference is less than abstol

• reltol (float) – the relative tolerance. first and second are considered equivalent if their absolute difference divided by the largest of first and second is less than reltol

• allow_second_superset (bool) – If True, then extra entries in containers found on second will not trigger a failure.

• item_callback (function) – items (other than Sequence / Mapping containers, matching strings, and items satisfying is) are passed to this callback to generate the (nominally floating point) value to use for comparison.

assertTrue(expr, msg=None)

Check that the expression is true.

assertTupleEqual(tuple1, tuple2, msg=None)

A tuple-specific equality assertion.

Parameters:

• 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.

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

Parameters:

• 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.

debug()

Run the test without collecting errors in a TestResult

classmethod doClassCleanups()

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

doCleanups()

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

classmethod enterClassContext(cm)

Same as enterContext, but class-wide.

enterContext(cm)

Enters the supplied context manager.

If successful, also adds its __exit__ method as a cleanup function and returns the result of the __enter__ method.

fail(msg=None)

Fail immediately, with the given message.

setUp()

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

classmethod setUpClass()

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.

subTest(msg=<object object>, **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()

Hook method for deconstructing the test fixture after testing it.

classmethod tearDownClass()

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

maxDiff = None