[Python-checkins] r70864 - in python/trunk/Lib: test/test_unittest.py unittest.py
gregory.p.smith
python-checkins at python.org
Tue Mar 31 21:03:29 CEST 2009
Author: gregory.p.smith
Date: Tue Mar 31 21:03:28 2009
New Revision: 70864
Log:
Rename the actual method definitions to the official assertFoo names.
Adds unittests to make sure the old fail* names continue to work now
and adds a comment that they are pending deprecation.
Also adds a test to confirm that the plural Equals method variants
continue to exist even though we're unlikely to deprecate those.
http://bugs.python.org/issue2578
Modified:
python/trunk/Lib/test/test_unittest.py
python/trunk/Lib/unittest.py
Modified: python/trunk/Lib/test/test_unittest.py
==============================================================================
--- python/trunk/Lib/test/test_unittest.py (original)
+++ python/trunk/Lib/test/test_unittest.py Tue Mar 31 21:03:28 2009
@@ -2283,7 +2283,6 @@
'Tests shortDescription() for a method with a longer '
'docstring.'))
-
def testAddTypeEqualityFunc(self):
class SadSnake(object):
"""Dummy class for test_addTypeEqualityFunc."""
@@ -2658,6 +2657,33 @@
self.assertRaisesRegexp, Exception,
re.compile('^Expected$'), Stub)
+ def testSynonymAssertMethodNames(self):
+ """Test undocumented method name synonyms.
+
+ Please do not use these methods names in your own code.
+
+ This test confirms their continued existence and functionality
+ in order to avoid breaking existing code.
+ """
+ self.assertNotEquals(3, 5)
+ self.assertEquals(3, 3)
+ self.assertAlmostEquals(2.0, 2.0)
+ self.assertNotAlmostEquals(3.0, 5.0)
+ self.assert_(True)
+
+ def testPendingDeprecationMethodNames(self):
+ """Test fail* methods pending deprecation, they will warn in 3.2.
+
+ Do not use these methods. They will go away in 3.3.
+ """
+ self.failIfEqual(3, 5)
+ self.failUnlessEqual(3, 3)
+ self.failUnlessAlmostEqual(2.0, 2.0)
+ self.failIfAlmostEqual(3.0, 5.0)
+ self.failUnless(True)
+ self.failUnlessRaises(TypeError, lambda _: 3.14 + u'spam')
+ self.failIf(False)
+
class Test_TestSkipping(TestCase):
Modified: python/trunk/Lib/unittest.py
==============================================================================
--- python/trunk/Lib/unittest.py (original)
+++ python/trunk/Lib/unittest.py Tue Mar 31 21:03:28 2009
@@ -467,17 +467,17 @@
"""Fail immediately, with the given message."""
raise self.failureException(msg)
- def failIf(self, expr, msg=None):
+ def assertFalse(self, expr, msg=None):
"Fail the test if the expression is true."
if expr:
raise self.failureException(msg)
- def failUnless(self, expr, msg=None):
+ def assertTrue(self, expr, msg=None):
"""Fail the test unless the expression is true."""
if not expr:
raise self.failureException(msg)
- def failUnlessRaises(self, excClass, callableObj=None, *args, **kwargs):
+ def assertRaises(self, excClass, callableObj=None, *args, **kwargs):
"""Fail unless an exception of class excClass is thrown
by callableObj when invoked with arguments args and keyword
arguments kwargs. If a different type of exception is
@@ -488,7 +488,7 @@
If called with callableObj omitted or None, will return a
context object used like this::
- with self.failUnlessRaises(some_error_class):
+ with self.assertRaises(some_error_class):
do_something()
"""
context = _AssertRaisesContext(excClass, self)
@@ -524,21 +524,21 @@
if not first == second:
raise self.failureException(msg or '%r != %r' % (first, second))
- def failUnlessEqual(self, first, second, msg=None):
+ 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 failIfEqual(self, first, second, msg=None):
+ def assertNotEqual(self, first, second, msg=None):
"""Fail if the two objects are equal as determined by the '=='
operator.
"""
if first == second:
raise self.failureException(msg or '%r == %r' % (first, second))
- def failUnlessAlmostEqual(self, first, second, places=7, msg=None):
+ def assertAlmostEqual(self, first, second, places=7, msg=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.
@@ -550,7 +550,7 @@
raise self.failureException(
msg or '%r != %r within %r places' % (first, second, places))
- def failIfAlmostEqual(self, first, second, places=7, msg=None):
+ def assertNotAlmostEqual(self, first, second, places=7, msg=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.
@@ -564,19 +564,24 @@
# Synonyms for assertion methods
- assertEqual = assertEquals = failUnlessEqual
-
- assertNotEqual = assertNotEquals = failIfEqual
-
- assertAlmostEqual = assertAlmostEquals = failUnlessAlmostEqual
-
- assertNotAlmostEqual = assertNotAlmostEquals = failIfAlmostEqual
-
- assertRaises = failUnlessRaises
-
- assert_ = assertTrue = failUnless
-
- assertFalse = failIf
+ # The plurals are undocumented. Keep them that way to discourage use.
+ # Do not add more. Do not remove.
+ # Going through a deprecation cycle on these would annoy many people.
+ assertEquals = assertEqual
+ assertNotEquals = assertNotEqual
+ assertAlmostEquals = assertAlmostEqual
+ assertNotAlmostEquals = assertNotAlmostEqual
+ assert_ = assertTrue
+
+ # These fail* assertion method names are pending deprecation and will
+ # be a deprecation warning in 3.2; http://bugs.python.org/issue2578
+ failUnlessEqual = assertEqual
+ failIfEqual = assertNotEqual
+ failUnlessAlmostEqual = assertAlmostEqual
+ failIfAlmostEqual = assertNotAlmostEqual
+ failUnless = assertTrue
+ failUnlessRaises = assertRaises
+ failIf = assertFalse
def assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None):
More information about the Python-checkins
mailing list