mirror of
https://github.com/python/cpython.git
synced 2025-12-04 00:30:19 +00:00
Issue 10573: revert unittest docs to first / second
Minor internal change to unittest.TestCase.assertCountEqual Reviewed by R. David Murray
This commit is contained in:
parent
66c908e6bf
commit
e180d3953f
2 changed files with 36 additions and 36 deletions
|
|
@ -860,12 +860,12 @@ Test cases
|
||||||
accept a *msg* argument that, if specified, is used as the error message on
|
accept a *msg* argument that, if specified, is used as the error message on
|
||||||
failure (see also :data:`longMessage`).
|
failure (see also :data:`longMessage`).
|
||||||
|
|
||||||
.. method:: assertEqual(actual, expected, msg=None)
|
.. method:: assertEqual(first, second, msg=None)
|
||||||
|
|
||||||
Test that *actual* and *expected* are equal. If the values do not
|
Test that *first* and *second* are equal. If the values do not
|
||||||
compare equal, the test will fail.
|
compare equal, the test will fail.
|
||||||
|
|
||||||
In addition, if *actual* and *expected* are the exact same type and one of
|
In addition, if *first* and *second* are the exact same type and one of
|
||||||
list, tuple, dict, set, frozenset or str or any type that a subclass
|
list, tuple, dict, set, frozenset or str or any type that a subclass
|
||||||
registers with :meth:`addTypeEqualityFunc` the type specific equality
|
registers with :meth:`addTypeEqualityFunc` the type specific equality
|
||||||
function will be called in order to generate a more useful default
|
function will be called in order to generate a more useful default
|
||||||
|
|
@ -880,9 +880,9 @@ Test cases
|
||||||
function for comparing strings.
|
function for comparing strings.
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertNotEqual(actual, expected, msg=None)
|
.. method:: assertNotEqual(first, second, msg=None)
|
||||||
|
|
||||||
Test that *actual* and *expected* are not equal. If the values do
|
Test that *first* and *second* are not equal. If the values do
|
||||||
compare equal, the test will fail.
|
compare equal, the test will fail.
|
||||||
|
|
||||||
.. method:: assertTrue(expr, msg=None)
|
.. method:: assertTrue(expr, msg=None)
|
||||||
|
|
@ -897,10 +897,10 @@ Test cases
|
||||||
provide a better error message in case of failure.
|
provide a better error message in case of failure.
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertIs(actual, expected, msg=None)
|
.. method:: assertIs(first, second, msg=None)
|
||||||
assertIsNot(actual, expected, msg=None)
|
assertIsNot(first, second, msg=None)
|
||||||
|
|
||||||
Test that *actual* and *expected* evaluate (or don't evaluate) to the
|
Test that *first* and *second* evaluate (or don't evaluate) to the
|
||||||
same object.
|
same object.
|
||||||
|
|
||||||
.. versionadded:: 3.1
|
.. versionadded:: 3.1
|
||||||
|
|
@ -1096,17 +1096,17 @@ Test cases
|
||||||
+---------------------------------------+--------------------------------+--------------+
|
+---------------------------------------+--------------------------------+--------------+
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertAlmostEqual(actual, expected, places=7, msg=None, delta=None)
|
.. method:: assertAlmostEqual(first, second, places=7, msg=None, delta=None)
|
||||||
assertNotAlmostEqual(actual, expected, places=7, msg=None, delta=None)
|
assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)
|
||||||
|
|
||||||
Test that *actual* and *expected* are approximately (or not approximately)
|
Test that *first* and *second* are approximately (or not approximately)
|
||||||
equal by computing the difference, rounding to the given number of
|
equal by computing the difference, rounding to the given number of
|
||||||
decimal *places* (default 7), and comparing to zero. Note that these
|
decimal *places* (default 7), and comparing to zero. Note that these
|
||||||
methods round the values to the given number of *decimal places* (i.e.
|
methods round the values to the given number of *decimal places* (i.e.
|
||||||
like the :func:`round` function) and not *significant digits*.
|
like the :func:`round` function) and not *significant digits*.
|
||||||
|
|
||||||
If *delta* is supplied instead of *places* then the difference
|
If *delta* is supplied instead of *places* then the difference
|
||||||
between *actual* and *expected* must be less (or more) than *delta*.
|
between *first* and *second* must be less (or more) than *delta*.
|
||||||
|
|
||||||
Supplying both *delta* and *places* raises a ``TypeError``.
|
Supplying both *delta* and *places* raises a ``TypeError``.
|
||||||
|
|
||||||
|
|
@ -1116,12 +1116,12 @@ Test cases
|
||||||
if the objects compare equal. Added the *delta* keyword argument.
|
if the objects compare equal. Added the *delta* keyword argument.
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertGreater(actual, expected, msg=None)
|
.. method:: assertGreater(first, second, msg=None)
|
||||||
assertGreaterEqual(actual, expected, msg=None)
|
assertGreaterEqual(first, second, msg=None)
|
||||||
assertLess(actual, expected, msg=None)
|
assertLess(first, second, msg=None)
|
||||||
assertLessEqual(actual, expected, msg=None)
|
assertLessEqual(first, second, msg=None)
|
||||||
|
|
||||||
Test that *actual* is respectively >, >=, < or <= than *expected* depending
|
Test that *first* is respectively >, >=, < or <= than *second* depending
|
||||||
on the method name. If not, the test will fail::
|
on the method name. If not, the test will fail::
|
||||||
|
|
||||||
>>> self.assertGreaterEqual(3, 4)
|
>>> self.assertGreaterEqual(3, 4)
|
||||||
|
|
@ -1177,14 +1177,14 @@ Test cases
|
||||||
|
|
||||||
.. versionadded:: 3.2
|
.. versionadded:: 3.2
|
||||||
|
|
||||||
.. method:: assertSameElements(actual, expected, msg=None)
|
.. method:: assertSameElements(first, second, msg=None)
|
||||||
|
|
||||||
Test that sequence *actual* contains the same elements as *expected*,
|
Test that sequence *first* contains the same elements as *second*,
|
||||||
regardless of their order. When they don't, an error message listing
|
regardless of their order. When they don't, an error message listing
|
||||||
the differences between the sequences will be generated.
|
the differences between the sequences will be generated.
|
||||||
|
|
||||||
Duplicate elements are ignored when comparing *actual* and *expected*.
|
Duplicate elements are ignored when comparing *first* and *second*.
|
||||||
It is the equivalent of ``assertEqual(set(actual), set(expected))``
|
It is the equivalent of ``assertEqual(set(first), set(second))``
|
||||||
but it works with sequences of unhashable objects as well. Because
|
but it works with sequences of unhashable objects as well. Because
|
||||||
duplicates are ignored, this method has been deprecated in favour of
|
duplicates are ignored, this method has been deprecated in favour of
|
||||||
:meth:`assertCountEqual`.
|
:meth:`assertCountEqual`.
|
||||||
|
|
@ -1241,9 +1241,9 @@ Test cases
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertMultiLineEqual(actual, expected, msg=None)
|
.. method:: assertMultiLineEqual(first, second, msg=None)
|
||||||
|
|
||||||
Test that the multiline string *actual* is equal to the string *expected*.
|
Test that the multiline string *first* is equal to the string *second*.
|
||||||
When not equal a diff of the two strings highlighting the differences
|
When not equal a diff of the two strings highlighting the differences
|
||||||
will be included in the error message. This method is used by default
|
will be included in the error message. This method is used by default
|
||||||
when comparing strings with :meth:`assertEqual`.
|
when comparing strings with :meth:`assertEqual`.
|
||||||
|
|
@ -1251,10 +1251,10 @@ Test cases
|
||||||
.. versionadded:: 3.1
|
.. versionadded:: 3.1
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertSequenceEqual(actual, expected, msg=None, seq_type=None)
|
.. method:: assertSequenceEqual(first, second, msg=None, seq_type=None)
|
||||||
|
|
||||||
Tests that two sequences are equal. If a *seq_type* is supplied, both
|
Tests that two sequences are equal. If a *seq_type* is supplied, both
|
||||||
*actual* and *expected* must be instances of *seq_type* or a failure will
|
*first* and *second* must be instances of *seq_type* or a failure will
|
||||||
be raised. If the sequences are different an error message is
|
be raised. If the sequences are different an error message is
|
||||||
constructed that shows the difference between the two.
|
constructed that shows the difference between the two.
|
||||||
|
|
||||||
|
|
@ -1265,8 +1265,8 @@ Test cases
|
||||||
.. versionadded:: 3.1
|
.. versionadded:: 3.1
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertListEqual(actual, expected, msg=None)
|
.. method:: assertListEqual(first, second, msg=None)
|
||||||
assertTupleEqual(actual, expected, msg=None)
|
assertTupleEqual(first, second, msg=None)
|
||||||
|
|
||||||
Tests that two lists or tuples are equal. If not an error message is
|
Tests that two lists or tuples are equal. If not an error message is
|
||||||
constructed that shows only the differences between the two. An error
|
constructed that shows only the differences between the two. An error
|
||||||
|
|
@ -1277,19 +1277,19 @@ Test cases
|
||||||
.. versionadded:: 3.1
|
.. versionadded:: 3.1
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertSetEqual(actual, expected, msg=None)
|
.. method:: assertSetEqual(first, second, msg=None)
|
||||||
|
|
||||||
Tests that two sets are equal. If not, an error message is constructed
|
Tests that two sets are equal. If not, an error message is constructed
|
||||||
that lists the differences between the sets. This method is used by
|
that lists the differences between the sets. This method is used by
|
||||||
default when comparing sets or frozensets with :meth:`assertEqual`.
|
default when comparing sets or frozensets with :meth:`assertEqual`.
|
||||||
|
|
||||||
Fails if either of *actual* or *expected* does not have a :meth:`set.difference`
|
Fails if either of *first* or *second* does not have a :meth:`set.difference`
|
||||||
method.
|
method.
|
||||||
|
|
||||||
.. versionadded:: 3.1
|
.. versionadded:: 3.1
|
||||||
|
|
||||||
|
|
||||||
.. method:: assertDictEqual(actual, expected, msg=None)
|
.. method:: assertDictEqual(first, second, msg=None)
|
||||||
|
|
||||||
Test that two dictionaries are equal. If not, an error message is
|
Test that two dictionaries are equal. If not, an error message is
|
||||||
constructed that shows the differences in the dictionaries. This
|
constructed that shows the differences in the dictionaries. This
|
||||||
|
|
|
||||||
|
|
@ -1022,17 +1022,17 @@ class TestCase(object):
|
||||||
- [0, 0, 1] and [0, 1] compare unequal.
|
- [0, 0, 1] and [0, 1] compare unequal.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
actual_seq, expected_seq = list(first), list(second)
|
first_seq, second_seq = list(first), list(second)
|
||||||
try:
|
try:
|
||||||
actual = collections.Counter(actual_seq)
|
first = collections.Counter(first_seq)
|
||||||
expected = collections.Counter(expected_seq)
|
second = collections.Counter(second_seq)
|
||||||
except TypeError:
|
except TypeError:
|
||||||
# Handle case with unhashable elements
|
# Handle case with unhashable elements
|
||||||
differences = _count_diff_all_purpose(actual_seq, expected_seq)
|
differences = _count_diff_all_purpose(first_seq, second_seq)
|
||||||
else:
|
else:
|
||||||
if actual == expected:
|
if first == second:
|
||||||
return
|
return
|
||||||
differences = _count_diff_hashable(actual_seq, expected_seq)
|
differences = _count_diff_hashable(first_seq, second_seq)
|
||||||
|
|
||||||
if differences:
|
if differences:
|
||||||
standardMsg = 'Element counts were not equal:\n'
|
standardMsg = 'Element counts were not equal:\n'
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue