Fix #1131 Add the method to check equality in Block Kit model classes (#1137)

horn553 · seratch · web-flow · commit 07d1dbfba489 · 2021-11-24T17:15:19.000+09:00
Co-authored-by: Kazuhiro Sera &lt;seratch@gmail.com&gt;
diff --git a/slack_sdk/models/basic_objects.py b/slack_sdk/models/basic_objects.py
@@ -87,6 +87,11 @@ def __repr__(self):
         else:
             return self.__str__()
 
+    def __eq__(self, other: Any) -> bool:
+        if not isinstance(other, JsonObject):
+            return False
+        return self.to_dict() == other.to_dict()
+
 
 class JsonValidator:
     def __init__(self, message: str):
diff --git a/tests/slack_sdk/models/test_blocks.py b/tests/slack_sdk/models/test_blocks.py
@@ -54,6 +54,11 @@ def test_parse(self):
             block.to_dict(),
         )
 
+    def test_eq(self):
+        self.assertEqual(Block(), Block())
+        self.assertEqual(Block(type="test"), Block(type="test"))
+        self.assertNotEqual(Block(type="test"), Block(type="another test"))
+
 
 # ----------------------------------------------
 # Section
diff --git a/tests/slack_sdk/models/test_elements.py b/tests/slack_sdk/models/test_elements.py
@@ -2,6 +2,7 @@
 
 from slack_sdk.errors import SlackObjectFormationError
 from slack_sdk.models.blocks import (
+    BlockElement,
     ButtonElement,
     DatePickerElement,
     TimePickerElement,
@@ -29,6 +30,15 @@
 from . import STRING_3001_CHARS, STRING_301_CHARS
 
 
+class BlockElementTests(unittest.TestCase):
+    def test_eq(self):
+        self.assertEqual(BlockElement(), BlockElement())
+        self.assertEqual(BlockElement(type="test"), BlockElement(type="test"))
+        self.assertNotEqual(
+            BlockElement(type="test"), BlockElement(type="another test")
+        )
+
+
 # -------------------------------------------------
 # Interactive Elements
 # -------------------------------------------------
diff --git a/tests/slack_sdk/models/test_objects.py b/tests/slack_sdk/models/test_objects.py
@@ -148,6 +148,14 @@ def test_get_non_null_attributes_nested_2(self):
         )
         self.assertDictEqual(expected, nested.get_non_null_attributes())
 
+    def test_eq(self):
+        obj1 = SimpleJsonObject()
+        self.assertEqual(self.good_test_object, obj1)
+
+        obj2 = SimpleJsonObject()
+        obj2.test = "another"
+        self.assertNotEqual(self.good_test_object, obj2)
+
 
 class JsonValidatorTests(unittest.TestCase):
     def setUp(self) -> None:
diff --git a/tests/slack_sdk/models/test_views.py b/tests/slack_sdk/models/test_views.py
@@ -531,3 +531,15 @@ def test_load_home_tab_view_005(self):
     def test_load_home_tab_view_006(self):
         with open("tests/slack_sdk_fixture/view_home_006.json") as file:
             self.verify_loaded_view_object(file)
+
+    def test_eq(self):
+        input = {
+            "type": "modal",
+            "blocks": [DividerBlock()],
+        }
+        another_input = {
+            "type": "modal",
+            "blocks": [DividerBlock(), DividerBlock()],
+        }
+        self.assertEqual(View(**input), View(**input))
+        self.assertNotEqual(View(**input), View(**another_input))
