rspec/rules/S5845/python/rule.adoc

52 lines
1.5 KiB
Plaintext
Raw Normal View History

2021-01-27 13:42:22 +01:00
Calling ``++unittest++`` methods ``++assertEqual++``, ``++assertNotEqual++``, ``++assertIs++`` or ``++assertIsNot++`` on objects of incompatible types will always fail or always succeed.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
For methods ``++assertEqual++`` and ``++assertNotEqual++``, arguments' types are incompatible if:
2021-02-02 15:02:10 +01:00
they are unrelated builtin types such as string and integer.
2021-02-02 15:02:10 +01:00
they are instances of unrelated classes which do not implement ``++__eq__++`` or ``++__ne__++`` (if a class implements one of these methods it could compare to any other type it wants).
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
As for methods ``++assertIs++`` and ``++assertIsNot++``, if arguments' types are different it is not possible for them to point to the same object, thus ``++assertIs++`` will always fail and ``++assertIsNot++`` will always succeed.
== Noncompliant Code Example
----
import unittest
class A(): ...
class MyTest(unittest.TestCase):
def test_something(self):
a = A()
mydict = {"x": a}
self.assertEqual(a, "x") # Noncompliant
self.assertIs(a, "x") # Noncompliant
----
== Compliant Solution
----
import unittest
class A(): ...
class MyTest(unittest.TestCase):
def test_something(self):
a = A()
mydict = {"x": a}
self.assertEqual(a, mydict["x"]) # OK
self.assertIs(a, mydict["x"]) # OK
----
== See
* S2159 Silly equality checks should not be made
* S3403 Identity operators should not be used with dissimilar types
ifdef::env-github,rspecator-view[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]