refactor: Replace 'pm_' with 'dm_' - rebased.

Author: Ajnus

docs/developer-feature-tutorial.md

@@ -115,7 +115,7 @@ To check for the above conditions, we create a function in `ui.py`:
     def handle_typing_event(self, event: Dict['str', Any]) -> None:
         # If the user is in dm narrow with the person typing
         if len(self.model.narrow) == 1 and\
-                self.model.narrow[0][0] == 'pm_with' and\
+                self.model.narrow[0][0] == 'dm_with' and\
                 event['sender']['email'] in self.model.narrow[0][1].split(','):
             if event['op'] == 'start':
                 user = self.model.user_dict[event['sender']['email']]

tests/conftest.py

@@ -500,7 +500,7 @@ def extra_stream_msg_template() -> Message:
 
 
 @pytest.fixture
-def pm_template() -> Message:
+def dm_template() -> Message:
     recipients = display_recipient_factory([(5179, "Boo Boo"), (5140, "Foo Foo")])
     return msg_template_factory(537287, "private", 1520918736, recipients=recipients)
 
@@ -513,18 +513,18 @@ def group_dm_template() -> Message:
     return msg_template_factory(537288, "private", 1520918737, recipients=recipients)
 
 
-@pytest.fixture(params=["pm_template", "group_dm_template"])
+@pytest.fixture(params=["dm_template", "group_dm_template"])
 def direct_message_fixture(request: Any) -> Message:
     return request.getfixturevalue(request.param)
 
 
 @pytest.fixture(
-    params=["stream_msg_template", "pm_template", "group_dm_template"],
-    ids=["stream_message", "pm_message", "group_pm_message"],
+    params=["stream_msg_template", "dm_template", "group_dm_template"],
+    ids=["stream_message", "dm_message", "group_dm_message"],
 )
 def message_fixture(request: Any) -> Message:
     """
-    Acts as a parametrize fixture for stream msg, dms and group_pms.
+    Acts as a parametrize fixture for stream msg, dms and group_dms.
     """
     # `request` currently does not have an exported Pytest type.
     # TODO: Use the exported type when it's made available.
@@ -535,7 +535,7 @@ def message_fixture(request: Any) -> Message:
 @pytest.fixture
 def messages_successful_response(
     stream_msg_template: Message,
-    pm_template: Message,
+    dm_template: Message,
     group_dm_template: Message,
 ) -> Dict[str, Any]:
     """
@@ -546,7 +546,7 @@ def messages_successful_response(
             "anchor": 10000000000000000,
             "messages": [
                 stream_msg_template,
-                pm_template,
+                dm_template,
                 group_dm_template,
             ],
             "result": "success",
@@ -634,10 +634,10 @@ def topics() -> List[str]:
     ],
     ids=[
         "stream_mention__stream_wildcard",
-        "stream+pm_mention__no_wildcard",
-        "no_mention__stream+pm_wildcard",
-        "stream+group_mention__pm_wildcard",
-        "pm_mention__stream+group_wildcard",
+        "stream+dm_mention__no_wildcard",
+        "no_mention__stream+dm_wildcard",
+        "stream+group_mention__dm_wildcard",
+        "dm_mention__stream+group_wildcard",
         "group_mention__all_wildcard",
         "all_mention__stream_wildcard",
         "stream+group_mention__wildcard",
@@ -1060,7 +1060,7 @@ def initial_index() -> Index:
 
 @pytest.fixture
 def empty_index(
-    stream_msg_template: Message, pm_template: Message, group_dm_template: Message
+    stream_msg_template: Message, dm_template: Message, group_dm_template: Message
 ) -> Index:
     return deepcopy(
         Index(
@@ -1079,7 +1079,7 @@ def empty_index(
                 lambda: {},
                 {
                     stream_msg_template["id"]: stream_msg_template,
-                    pm_template["id"]: pm_template,
+                    dm_template["id"]: dm_template,
                     group_dm_template["id"]: group_dm_template,
                 },
             ),
@@ -1140,7 +1140,7 @@ def index_multiple_topic_msg(
 @pytest.fixture
 def index_user(empty_index: Index) -> Index:
     """
-    Expected index of initial_data when model.narrow = [['pm_with',
+    Expected index of initial_data when model.narrow = [['dm_with',
                                                          'boo@zulip.com'],
     """
     user_ids = frozenset({5179, 5140})
@@ -1153,7 +1153,7 @@ def index_user(empty_index: Index) -> Index:
 @pytest.fixture
 def index_user_multiple(empty_index: Index) -> Index:
     """
-    Expected index of initial_data when model.narrow = [['pm_with',
+    Expected index of initial_data when model.narrow = [['dm_with',
                                             'boo@zulip.com, bar@zulip.com'],
     """
     user_ids = frozenset({5179, 5140, 5180})

tests/core/test_core.py

@@ -514,7 +514,7 @@ def test_stream_muting_confirmation_popup(
             "Default_all_msg_search",
             "redo_default_search",
             "search_within_stream",
-            "pm_search_again",
+            "dm_search_again",
             "search_within_topic_narrow",
         ],
     )

tests/model/test_model.py

@@ -407,9 +407,9 @@ def test_is_search_narrow(self, model, narrow, is_search_narrow):
         "bad_args",
         [
             dict(topic="some topic"),
-            dict(stream="foo", pm_with="someone"),
-            dict(topic="blah", pm_with="someone"),
-            dict(pm_with="someone", topic="foo"),
+            dict(stream="foo", dm_with="someone"),
+            dict(topic="blah", dm_with="someone"),
+            dict(dm_with="someone", topic="foo"),
         ],
     )
     def test_set_narrow_bad_input(self, model, bad_args):
@@ -428,7 +428,7 @@ def test_set_narrow_bad_input(self, model, bad_args):
             ([["is", "starred"]], dict(starred=True)),
             ([["is", "mentioned"]], dict(mentioned=True)),
             ([["is", "private"]], dict(pms=True)),
-            ([["pm-with", "FOO@zulip.com"]], dict(pm_with="FOO@zulip.com")),
+            ([["pm-with", "FOO@zulip.com"]], dict(dm_with="FOO@zulip.com")),
         ],
     )
     def test_set_narrow_already_set(self, model, narrow, good_args):
@@ -449,7 +449,7 @@ def test_set_narrow_already_set(self, model, narrow, good_args):
             ([], [["is", "starred"]], dict(starred=True)),
             ([], [["is", "mentioned"]], dict(mentioned=True)),
             ([], [["is", "private"]], dict(pms=True)),
-            ([], [["pm-with", "FOOBOO@gmail.com"]], dict(pm_with="FOOBOO@gmail.com")),
+            ([], [["pm-with", "FOOBOO@gmail.com"]], dict(dm_with="FOOBOO@gmail.com")),
         ],
     )
     def test_set_narrow_not_already_set(

tests/ui/test_ui_tools.py

@@ -1152,7 +1152,7 @@ def mock_external_classes(self, mocker):
     def test_menu_view(self, mocker):
         self.streams_view = mocker.patch(VIEWS + ".LeftColumnView.streams_view")
         home_button = mocker.patch(VIEWS + ".HomeButton")
-        pm_button = mocker.patch(VIEWS + ".PMButton")
+        dm_button = mocker.patch(VIEWS + ".PMButton")
         starred_button = mocker.patch(VIEWS + ".StarredButton")
         mocker.patch(VIEWS + ".urwid.ListBox")
         mocker.patch(VIEWS + ".urwid.SimpleFocusListWalker")
@@ -1161,7 +1161,7 @@ def test_menu_view(self, mocker):
         home_button.assert_called_once_with(
             controller=left_col_view.controller, count=2
         )
-        pm_button.assert_called_once_with(controller=left_col_view.controller, count=0)
+        dm_button.assert_called_once_with(controller=left_col_view.controller, count=0)
         starred_button.assert_called_once_with(
             controller=left_col_view.controller, count=3
         )

tests/ui_tools/test_boxes.py

@@ -186,7 +186,7 @@ def test_generic_autocomplete_stream_and_topic(
             ([1001], False, []),
             ([1001, 11], True, [11]),
         ],
-        ids=["pm_only_with_oneself", "group_pm"],
+        ids=["dm_only_with_oneself", "group_dm"],
     )
     def test_not_calling_typing_method_to_oneself(
         self,

tests/ui_tools/test_buttons.py

@@ -181,12 +181,12 @@ def test_update_widget(
 
 class TestPMButton:
     def test_button_text_length(self, mocker: MockerFixture, count: int = 10) -> None:
-        pm_button = PMButton(controller=mocker.Mock(), count=count)
-        assert len(pm_button.label_text) == 20
+        dm_button = PMButton(controller=mocker.Mock(), count=count)
+        assert len(dm_button.label_text) == 20
 
     def test_button_text_title(self, mocker: MockerFixture, count: int = 10) -> None:
-        pm_button = PMButton(controller=mocker.Mock(), count=count)
-        title_text = pm_button.label_text[:-3].strip()
+        dm_button = PMButton(controller=mocker.Mock(), count=count)
+        title_text = dm_button.label_text[:-3].strip()
         assert title_text == "Direct messages"
 
 

tests/ui_tools/test_messages.py

@@ -883,7 +883,7 @@ def test_main_view_generates_stream_header(
             {"type": "stream"},
         ],
         ids=[
-            "larger_pm_group",
+            "larger_dm_group",
             "stream_before",
         ],
     )

tests/ui_tools/test_popups.py

@@ -1023,8 +1023,8 @@ def test_keypress_any_key(
         ],
         ids=[
             "stream_message_id",
-            "pm_message_id",
-            "group_pm_message_id",
+            "dm_message_id",
+            "group_dm_message_id",
         ],
     )
     def test_keypress_edit_history(

zulipterminal/core.py

@@ -645,7 +645,7 @@ def narrow_to_user(
     ) -> None:
         self._narrow_to(
             anchor=contextual_message_id,
-            pm_with=", ".join(recipient_emails),
+            dm_with=", ".join(recipient_emails),
         )
 
     def narrow_to_all_messages(