refactor: conftest: Make display_recipient_factory a fixture.

This commit adds the pytest fixture decorator to display_recipient_
factory() function, allowing it to be reused separately throughout
the codebase.

Author: zee-bit

tests/conftest.py

@@ -260,24 +260,27 @@ def zulip_emoji():
     return OrderedDict([("zulip", {"code": "zulip", "type": "zulip_extra_emoji"})])
 
 
-def display_recipient_factory(
-    recipient_id: Optional[int] = None, recipient_name: str = ""
-):
+@pytest.fixture
+def display_recipient_factory():
     """
     Generate display_recipient field for (stream/PM/group) messages
     FIXME: Refactor other tests to make this depend only on recipient_id.
     """
-    return (
-        {
-            "id": recipient_id,
-            "is_mirror_dummy": False,
-            "full_name": recipient_name,
-            "short_name": f"{recipient_id}",
-            "email": f"user-{recipient_id}@zulip.com",
-        }
-        if recipient_id
-        else "PTEST"
-    )
+
+    def _factory(recipient_id: Optional[int] = None, recipient_name: str = ""):
+        return (
+            {
+                "id": recipient_id,
+                "is_mirror_dummy": False,
+                "full_name": recipient_name,
+                "short_name": f"{recipient_id}",
+                "email": f"user-{recipient_id}@zulip.com",
+            }
+            if recipient_id
+            else "PTEST"
+        )
+
+    return _factory
 
 
 @pytest.fixture
@@ -320,14 +323,14 @@ def _factory(
 
 
 @pytest.fixture
-def stream_msg_template(msg_template_factory):
+def stream_msg_template(display_recipient_factory, msg_template_factory):
     recipient = display_recipient_factory()
     msg_template = msg_template_factory(537286, "stream", 205, 1520918722, recipient)
     return msg_template
 
 
 @pytest.fixture
-def pm_template(msg_template_factory):
+def pm_template(display_recipient_factory, msg_template_factory):
     recipients = [
         display_recipient_factory(_id, name)
         for _id, name in {(5179, "Boo Boo"), (5140, "Foo Foo")}
@@ -337,7 +340,7 @@ def pm_template(msg_template_factory):
 
 
 @pytest.fixture
-def group_pm_template(msg_template_factory):
+def group_pm_template(display_recipient_factory, msg_template_factory):
     recipients = [
         display_recipient_factory(_id, name)
         for _id, name in {(5179, "Boo Boo"), (5140, "Foo Foo"), (5180, "Bar Bar")}