refactor: Replace 'private_' with 'direct_'. - rebased.

Author: Ajnus

tests/conftest.py

@@ -514,7 +514,7 @@ def group_pm_template() -> Message:
 
 
 @pytest.fixture(params=["pm_template", "group_pm_template"])
-def private_message_fixture(request: Any) -> Message:
+def direct_message_fixture(request: Any) -> Message:
     return request.getfixturevalue(request.param)
 
 
@@ -1068,8 +1068,8 @@ def empty_index(
             all_msg_ids=set(),
             starred_msg_ids=set(),
             mentioned_msg_ids=set(),
-            private_msg_ids=set(),
-            private_msg_ids_by_user_ids=defaultdict(set, {}),
+            direct_msg_ids=set(),
+            direct_msg_ids_by_user_ids=defaultdict(set, {}),
             stream_msg_ids_by_stream_id=defaultdict(set, {}),
             topic_msg_ids=defaultdict(dict, {}),
             edited_messages=set(),
@@ -1104,7 +1104,7 @@ def index_stream(empty_index: Index) -> Index:
     """
     index = empty_index
     index["stream_msg_ids_by_stream_id"] = defaultdict(set, {205: {537286}})
-    index["private_msg_ids"] = {537287, 537288}
+    index["direct_msg_ids"] = {537287, 537288}
     return index
 
 
@@ -1145,8 +1145,8 @@ def index_user(empty_index: Index) -> Index:
     """
     user_ids = frozenset({5179, 5140})
     index = empty_index
-    index["private_msg_ids_by_user_ids"] = defaultdict(set, {user_ids: {537287}})
-    index["private_msg_ids"] = {537287, 537288}
+    index["direct_msg_ids_by_user_ids"] = defaultdict(set, {user_ids: {537287}})
+    index["direct_msg_ids"] = {537287, 537288}
     return index
 
 
@@ -1158,8 +1158,8 @@ def index_user_multiple(empty_index: Index) -> Index:
     """
     user_ids = frozenset({5179, 5140, 5180})
     index = empty_index
-    index["private_msg_ids_by_user_ids"] = defaultdict(set, {user_ids: {537288}})
-    index["private_msg_ids"] = {537287, 537288}
+    index["direct_msg_ids_by_user_ids"] = defaultdict(set, {user_ids: {537288}})
+    index["direct_msg_ids"] = {537287, 537288}
     return index
 
 
@@ -1178,7 +1178,7 @@ def index_all_starred(empty_index: Index, request: Any) -> Index:
     msgs_with_stars = request.param
     index = empty_index
     index["starred_msg_ids"] = msgs_with_stars
-    index["private_msg_ids"] = {537287, 537288}
+    index["direct_msg_ids"] = {537287, 537288}
     for msg_id, msg in index["messages"].items():
         if msg_id in msgs_with_stars and "starred" not in msg["flags"]:
             msg["flags"].append("starred")
@@ -1192,7 +1192,7 @@ def index_all_mentions(
     mentioned_messages, wildcard_mentioned_messages = mentioned_messages_combination
     index = empty_index
     index["mentioned_msg_ids"] = mentioned_messages | wildcard_mentioned_messages
-    index["private_msg_ids"] = {537287, 537288}
+    index["direct_msg_ids"] = {537287, 537288}
     for msg_id, msg in index["messages"].items():
         if msg_id in mentioned_messages and "mentioned" not in msg["flags"]:
             msg["flags"].append("mentioned")

tests/core/test_core.py

@@ -247,7 +247,7 @@ def test_narrow_to_user(
         recipients = frozenset([controller.model.user_id, user_id])
         assert controller.model.recipients == recipients
         widget = controller.view.message_view.log.extend.call_args_list[0][0][0][0]
-        id_list = index_user["private_msg_ids_by_user_ids"][recipients]
+        id_list = index_user["direct_msg_ids_by_user_ids"][recipients]
         assert {widget.original_widget.message["id"]} == id_list
 
     @pytest.mark.parametrize(
@@ -302,7 +302,7 @@ def test_narrow_to_all_pm(
         controller.view.message_view.log.clear.assert_called_once_with()
 
         widgets = controller.view.message_view.log.extend.call_args_list[0][0][0]
-        id_list = index_user["private_msg_ids"]
+        id_list = index_user["direct_msg_ids"]
         msg_ids = {widget.original_widget.message["id"] for widget in widgets}
         assert msg_ids == id_list
 

tests/helper/test_helper.py

@@ -178,7 +178,7 @@ def test_index_starred(
     model.narrow = [["is", "starred"]]
     model.is_search_narrow.return_value = False
     expected_index: Dict[str, Any] = dict(
-        empty_index, private_msg_ids={537287, 537288}, starred_msg_ids=msgs_with_stars
+        empty_index, direct_msg_ids={537287, 537288}, starred_msg_ids=msgs_with_stars
     )
     for msg_id, msg in expected_index["messages"].items():
         if msg_id in msgs_with_stars and "starred" not in msg["flags"]:
@@ -211,7 +211,7 @@ def test_index_mentioned_messages(
     model.is_search_narrow.return_value = False
     expected_index: Dict[str, Any] = dict(
         empty_index,
-        private_msg_ids={537287, 537288},
+        direct_msg_ids={537287, 537288},
         mentioned_msg_ids=(mentioned_messages | wildcard_mentioned_messages),
     )
 

tests/model/test_model.py

@@ -478,16 +478,16 @@ def test_set_narrow_not_already_set(
                 {"topic_msg_ids": {1: {"BOO": {0, 1}}}},
                 set(),
             ),
-            ([["is", "private"]], {"private_msg_ids": {0, 1}}, {0, 1}),
+            ([["is", "private"]], {"direct_msg_ids": {0, 1}}, {0, 1}),
             (
                 [["pm-with", "[email protected]"]],
-                {"private_msg_ids_by_user_ids": {frozenset({1, 2}): {0, 1}}},
+                {"direct_msg_ids_by_user_ids": {frozenset({1, 2}): {0, 1}}},
                 {0, 1},
             ),
             (
                 [["pm-with", "[email protected]"]],
                 {  # Covers recipient empty-set case
-                    "private_msg_ids_by_user_ids": {
+                    "direct_msg_ids_by_user_ids": {
                         frozenset({1, 3}): {0, 1}  # NOTE {1,3} not {1,2}
                     }
                 },
@@ -2283,12 +2283,12 @@ def test_notify_users_enabled(
         [(True, "New direct message from Foo Foo"), (False, "private content here.")],
     )
     def test_notify_users_hides_PM_content_based_on_user_setting(
-        self, mocker, model, private_message_fixture, hide_content, expected_content
+        self, mocker, model, direct_message_fixture, hide_content, expected_content
     ):
         notify = mocker.patch(MODULE + ".notify")
         model._user_settings["pm_content_in_desktop_notifications"] = not hide_content
 
-        message = private_message_fixture
+        message = direct_message_fixture
         message["user_id"] = 5179
         message["flags"] = []
 

zulipterminal/helper.py

@@ -104,8 +104,8 @@ class Index(TypedDict):
     all_msg_ids: Set[int]
     starred_msg_ids: Set[int]
     mentioned_msg_ids: Set[int]
-    private_msg_ids: Set[int]
-    private_msg_ids_by_user_ids: Dict[FrozenSet[int], Set[int]]
+    direct_msg_ids: Set[int]
+    direct_msg_ids_by_user_ids: Dict[FrozenSet[int], Set[int]]
     stream_msg_ids_by_stream_id: Dict[int, Set[int]]
     topic_msg_ids: Dict[int, Dict[str, Set[int]]]
     # Extra cached information
@@ -121,8 +121,8 @@ class Index(TypedDict):
     all_msg_ids=set(),
     starred_msg_ids=set(),
     mentioned_msg_ids=set(),
-    private_msg_ids=set(),
-    private_msg_ids_by_user_ids=defaultdict(set),
+    direct_msg_ids=set(),
+    direct_msg_ids_by_user_ids=defaultdict(set),
     stream_msg_ids_by_stream_id=defaultdict(set),
     topic_msg_ids=defaultdict(dict),
     edited_messages=set(),
@@ -322,7 +322,7 @@ def index_messages(messages: List[Message], model: Any, index: Index) -> Index:
                     ...
                 }
         },
-        'private_msg_ids_by_user_ids': {
+        'direct_msg_ids_by_user_ids': {
             (3, 7): {  # user_ids frozenset
                 51234,
                 56454,
@@ -345,7 +345,7 @@ def index_messages(messages: List[Message], model: Any, index: Index) -> Index:
             23423,
             ...
         },
-        'private_msg_ids': {
+        'direct_msg_ids': {
             22334,
             23423,
             ...
@@ -452,7 +452,7 @@ def index_messages(messages: List[Message], model: Any, index: Index) -> Index:
                 index["mentioned_msg_ids"].add(msg["id"])
 
             if msg["type"] == "private":
-                index["private_msg_ids"].add(msg["id"])
+                index["direct_msg_ids"].add(msg["id"])
                 recipients = frozenset(
                     {recipient["id"] for recipient in msg["display_recipient"]}
                 )
@@ -463,7 +463,7 @@ def index_messages(messages: List[Message], model: Any, index: Index) -> Index:
                         for email in narrow[0][1].split(", ")
                     ] + [model.user_id]
                     if recipients == frozenset(narrow_emails):
-                        index["private_msg_ids_by_user_ids"][recipients].add(msg["id"])
+                        index["direct_msg_ids_by_user_ids"][recipients].add(msg["id"])
 
             if msg["type"] == "stream" and msg["stream_id"] == model.stream_id:
                 index["stream_msg_ids_by_stream_id"][msg["stream_id"]].add(msg["id"])

zulipterminal/model.py

@@ -370,10 +370,10 @@ def get_message_ids_in_current_narrow(self) -> Set[int]:
                 topic = narrow[1][1]
                 ids = index["topic_msg_ids"][stream_id].get(topic, set())
         elif narrow[0][1] == "private":
-            ids = index["private_msg_ids"]
+            ids = index["direct_msg_ids"]
         elif narrow[0][0] == "pm-with":
             recipients = self.recipients
-            ids = index["private_msg_ids_by_user_ids"].get(recipients, set())
+            ids = index["direct_msg_ids_by_user_ids"].get(recipients, set())
         elif narrow[0][1] == "starred":
             ids = index["starred_msg_ids"]
         elif narrow[0][1] == "mentioned":